REST Data Formats

The table below describes the REST fields for forwarding alarm and journal entries to Northbound destinations.

Alarm Forwarding REST Fields

Entity Name

Type

Description

Alarm Forwarding

Journal Forwarding

name

String (1-100 chars)

The alarm title.

alarmType

String

Alarm type according to ITU X.733 definition. This value is displayed from the variable-binding.

isEvent

Boolean

Indicates whether the trap is an alarm or an event.

alarmTextualDescription

String (1-255 chars)

The alarm text description shown in the raised alarm.

alarmSource

String (1-255 chars)

Possible values of sources if applicable to a specific alarm. This value is displayed from the variable-binding tgTrapGlobalsSource.

alarmUniqId

■

String (1-255 chars)

■

The running number of alarms since the installation of the OVOC instance.

■

The value of this number should be managed by the system separately for alarms and events.

■

The Live Platform application uses this number to recognize if alarms were missed and to retrieve them using the Carrier-grade system.

■

The forwarded information includes Live Platform alarms sequencing for NMS carrier-grade alarms: where the running number events: always -1

NOTIFICATION-TYPE OID as it appears in the MIB. Corrective Action Possible corrective action when applicable. - 1

Max Integer

The unique database ID index for the alarm in the Live Platform portal database.

alarmCategory

ItuAlarmType

Alarm type according to ITU X.733 definition. This value is displayed from the variable-binding tgTrapGlobalsType.

alarmProbCause

ItuAlarmProbableCause

Alarm probable cause according to ITU X.733 definition. This value is displayed from the variable-binding tgTrapGlobalsProbableCause.

alarmAddInfo1

String (0-255 chars)

Additional information fields according to the specific scenario.

alarmAddInfo2

String (0-255 chars)

Additional information fields according to the specific scenario.

alarmAddInfo3

String (0-255 chars)

Additional information fields according to the specific scenario.

alarmSourceDescription

String (0-255 chars)

Possible values of sources if applicable to a specific alarm. This value is displayed from the variable-binding tgTrapGlobalsSource.

alarmSeverity

One of the following values:

■

cleared(0)

■

indeterminate(1)

■

warning(2)

■

minor(3)

■

major(4)

■

critical(5)

Each value represents the entire system severity when a specific alarm/event is issued.

Note: This varbind is not sent for system alarms (alarms that were generated by Live Platform such as Live Platform Disk Space alarm).

This value is displayed from the variable-binding tgTrapGlobalsSeverity. In addition, the Textual description value is displayed from the variablebinding tgTrapGlobalsTextualDescription.

alarmDateAndTime

Date

Date and time when the alarm was raised.

unitType

Entity Type

The entity type on which the alarm was raised:

■

NotRelevant = -1

■

Tenant = 0

■

Region = 1

■

Site = 2

■

Device = 3

■

Link = 4

■

Endpoint = 5

■

LdapUser = 6

■

Group = 7

■

ActiveDirectory = 25

■

ARM = 29

■

System = 100

alarmRemoteHost

IPv4/IPv6 // OPTIONAL

Remote host destination.

regionName

String (1-100 chars) //OPTIONAL

Name of the region upon which the alarm was raised.

unitName

String (1-100 chars) //OPTIONAL

The name of the entity on which the alarm was raised. For example, device or link name.

tenantName

String (1-100 chars) //OPTIONAL

Name of the managed tenant upon which the alarm was raised.

deviceInfo

{ // OPTIONAL - not sent in case it’s not a device alarm

“productType” : MGType

“serialNum” : String (0-510) //in case of HA device - SN1_SN2

"description" : String (0-255)

"severity" : ItuPerceivedSeverity

}

Alarm raised on the managed device e.g. gateway/SBC

operator

String (1-100 chars)

The name of the operator performing the journal action.

operatorIpAddress

String (1-100 chars)

The IP address of the operator performing the journal action.

The REST formats for forwarding alarm data are shown below.

Copy

“alarms” :
[
   {
“name” : String (1-100 chars),
“alarmType” : String,
“isEvent” : Boolean,
“alarmTextualDescription” : String (1-255 chars),
“alarmSource” : String (1-255 chars),
“alarmSeverity” : ItuPerceivedSeverity,
“alarmUniqId” : String (1-100 chars),
“alarmCategory” : ItuAlarmType,
“alarmProbCause” : ItuAlarmProbableCause,
“alarmAddInfo1” : String (0-255 chars),
“alarmAddInfo2” : String (0-255 chars),
“alarmAddInfo3” : String (0-255 chars),
“alarmSourceDescription” : String (0-255 chars),
“alarmDateAndTime” : Date,
“unitType” : EntityType
"alarmRemoteHost" : IPv4/IPv6 // OPTIONAL 
            "regionName " : String (1-100 chars) //OPTIONAL
             “unitName” : String (1-100 chars) //OPTIONAL
            "tenantName " : String (1-100 chars) //OPTIONAL
           “deviceInfo”:{ // OPTIONAL - not sent in case it’s not a device alarm
“productType” : MGType
“serialNum” : String (0-510) //in case of HA device - SN1_SN2
"description" : String (0-255)
"severity" :  ItuPerceivedSeverity
}
}]